Your suggested change has been received. Thank you.

close
back

BSIDCA endpoints

GrIDsure endpoints

search

GrIDsure endpoints

Please Note:

You are not viewing the most recent version of this page. 3.20(SP1) is the latest version available.

GrIDsure endpoints

copy link to clipboardAllocateGrIDsure

AllocateGrIDsure(System.Collections.Generic.List{System.String},DataLayer.Entity.Transaction.BillingStyle,System.Boolean,System.Boolean,System.String)

Allocate GrIDsure tokens to a child account.

copy link to clipboardParameters

Param: serials: List of serial numbers to allocate

Param: billingStyle: Billing style of the allocation: Allocation, Activation, Authentication or Transfer

Param: withCapacity: True to automatically add license capacity with the tokens

Param: isSale: True if this is a sale, false for rental.

Param: toOrganization: Account to allocate to

copy link to clipboardReturns:

  • True if allocated successfully

copy link to clipboardSOAP 1.1 sample

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/AllocateGrIDsure"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
    <AllocateGrIDsure xmlns="http://www.cryptocard.com/blackshield/">
    <serials>
        <string>string</string>
        <string>string</string>
    </serials>
    <billingStyle>Allocation or Activation or Authentication or Transfer</billingStyle>
    <withCapacity>boolean</withCapacity>
    <isSale>boolean</isSale>
    <toOrganization>string</toOrganization>
    </AllocateGrIDsure>
</soap:Body>
</soap:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
    <AllocateGrIDsureResponse xmlns="http://www.cryptocard.com/blackshield/">
    <AllocateGrIDsureResult>boolean</AllocateGrIDsureResult>
    </AllocateGrIDsureResponse>
</soap:Body>
</soap:Envelope>

copy link to clipboardSOAP 1.2 sample

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
    <AllocateGrIDsure xmlns="http://www.cryptocard.com/blackshield/">
    <serials>
        <string>string</string>
        <string>string</string>
    </serials>
    <billingStyle>Allocation or Activation or Authentication or Transfer</billingStyle>
    <withCapacity>boolean</withCapacity>
    <isSale>boolean</isSale>
    <toOrganization>string</toOrganization>
    </AllocateGrIDsure>
</soap12:Body>
</soap12:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
    <AllocateGrIDsureResponse xmlns="http://www.cryptocard.com/blackshield/">
    <AllocateGrIDsureResult>boolean</AllocateGrIDsureResult>
    </AllocateGrIDsureResponse>
</soap12:Body>
</soap12:Envelope>

copy link to clipboardAuthenticateGrIDsureToken

AuthenticateGrIDsureToken(System.String,System.String,System.String)

Authenticate a GrIDsure token

copy link to clipboardParameters

Param: userName: User with the token

Param: response: Reponse

Param: organization: Account

copy link to clipboardReturns

  • True if successful

copy link to clipboardSOAP 1.1 sample

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/AuthenticateGrIDsureToken"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
    <AuthenticateGrIDsureToken xmlns="http://www.cryptocard.com/blackshield/">
    <userName>string</userName>
    <response>string</response>
    <organization>string</organization>
    </AuthenticateGrIDsureToken>
</soap:Body>
</soap:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
    <AuthenticateGrIDsureTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
    <AuthenticateGrIDsureTokenResult>boolean</AuthenticateGrIDsureTokenResult>
    </AuthenticateGrIDsureTokenResponse>
</soap:Body>
</soap:Envelope>

copy link to clipboardSOAP 1.2 sample

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
    <AuthenticateGrIDsureToken xmlns="http://www.cryptocard.com/blackshield/">
    <userName>string</userName>
    <response>string</response>
    <organization>string</organization>
    </AuthenticateGrIDsureToken>
</soap12:Body>
</soap12:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
    <AuthenticateGrIDsureTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
    <AuthenticateGrIDsureTokenResult>boolean</AuthenticateGrIDsureTokenResult>
    </AuthenticateGrIDsureTokenResponse>
</soap12:Body>
</soap12:Envelope>

copy link to clipboardHTTP GET sample

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

Request:

GET /bsidca/BSIDCA.asmx/AuthenticateGrIDsureToken?userName=string&response=string&organization=string HTTP/1.1
Host: cloud.eu.safenetid.com

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>

copy link to clipboardHTTP POST sample

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx/AuthenticateGrIDsureToken HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

userName=string&response=string&organization=string

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>

</ br>

copy link to clipboardDeallocateGrIDsure

DeallocateGrIDsure(System.Collections.Generic.List{System.String},System.Boolean,System.String,System.String)

De-allocate GrIDsure tokens from a child account.

copy link to clipboardParameters

Param: serials: List of serials to de-allocate from the child account

Param: isSale: True if tokens are being sold back up the chain.

Param: intoContainer: Container to place the tokens into

Param: fromOrganization: Account to move tokens from

copy link to clipboardReturns:

  • True if tokens are de-allocated

copy link to clipboardSOAP 1.1 sample

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/DeallocateGrIDsure"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
    <DeallocateGrIDsure xmlns="http://www.cryptocard.com/blackshield/">
    <serials>
        <string>string</string>
        <string>string</string>
    </serials>
    <isSale>boolean</isSale>
    <intoContainer>string</intoContainer>
    <fromOrganization>string</fromOrganization>
    </DeallocateGrIDsure>
</soap:Body>
</soap:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
    <DeallocateGrIDsureResponse xmlns="http://www.cryptocard.com/blackshield/">
    <DeallocateGrIDsureResult>boolean</DeallocateGrIDsureResult>
    </DeallocateGrIDsureResponse>
</soap:Body>
</soap:Envelope>

copy link to clipboardSOAP 1.2 sample

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.eu.safenetid.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
    <DeallocateGrIDsure xmlns="http://www.cryptocard.com/blackshield/">
    <serials>
        <string>string</string>
        <string>string</string>
    </serials>
    <isSale>boolean</isSale>
    <intoContainer>string</intoContainer>
    <fromOrganization>string</fromOrganization>
    </DeallocateGrIDsure>
</soap12:Body>
</soap12:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
    <DeallocateGrIDsureResponse xmlns="http://www.cryptocard.com/blackshield/">
    <DeallocateGrIDsureResult>boolean</DeallocateGrIDsureResult>
    </DeallocateGrIDsureResponse>
</soap12:Body>
</soap12:Envelope>

copy link to clipboardGetGrIDsurechallenge

GetGrIDsurechallenge(System.String,System.String)

Get a challenge string for a GrIDsure token. This string must be processed into an image and presented to the user.

copy link to clipboardParameters

Param: userName: User who is requesting the challenge

Param: organization: Account

copy link to clipboardReturns

  • GrIDsure challenge string

copy link to clipboardSOAP 1.1 sample

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/GetGrIDsurechallenge"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetGrIDsurechallenge xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <organization>string</organization>
    </GetGrIDsurechallenge>
  </soap:Body>
</soap:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetGrIDsurechallengeResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetGrIDsurechallengeResult>string</GetGrIDsurechallengeResult>
    </GetGrIDsurechallengeResponse>
  </soap:Body>
</soap:Envelope>

copy link to clipboardSOAP 1.2 sample

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetGrIDsurechallenge xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <organization>string</organization>
    </GetGrIDsurechallenge>
  </soap12:Body>
</soap12:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetGrIDsurechallengeResponse xmlns="http://www.cryptocard.com/blackshield/">
      <GetGrIDsurechallengeResult>string</GetGrIDsurechallengeResult>
    </GetGrIDsurechallengeResponse>
  </soap12:Body>
</soap12:Envelope>

copy link to clipboardHTTP GET sample

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

Request:

GET /bsidca/BSIDCA.asmx/GetGrIDsurechallenge?userName=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://www.cryptocard.com/blackshield/">string</string>

copy link to clipboardHTTP POST sample

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx/GetGrIDsurechallenge HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

userName=string&organization=string

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://www.cryptocard.com/blackshield/">string</string>

copy link to clipboardProvisionUsersGrIDsureTokens

ProvisionUsersGrIDsureTokens(System.Collections.Generic.List{System.String},System.String,System.String)

Provisions a list of users with GrIDsure tokens.

copy link to clipboardParameters

Param: userNames: Names of the users to provision tokens to

Param: description: Provisioning task description

Param: organization: Account

copy link to clipboardReturns

A list in the same order as the user names provided:

FailedToAddToBatch Failed to add user to provisioning task
EmailSent Success
UserHasNoEmail Can't provision to the user as they have no e-mail address
FailedToSendEmail Failed to send out the e-mail. Check e-mail settings for the account
CouldntGetToken Couldn't find an available SMS or MP token to use for SMS provisioning
CouldntAssignToken User could not be assigned an SMS token
UserHasActiveToken Cannot provision password as the user has an active token

copy link to clipboardSOAP 1.1 sample

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/ProvisionUsersGrIDsureTokens"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ProvisionUsersGrIDsureTokens xmlns="http://www.cryptocard.com/blackshield/">
      <userNames>
        <string>string</string>
        <string>string</string>
      </userNames>
      <description>string</description>
      <organization>string</organization>
    </ProvisionUsersGrIDsureTokens>
  </soap:Body>
</soap:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ProvisionUsersGrIDsureTokensResponse xmlns="http://www.cryptocard.com/blackshield/">
      <ProvisionUsersGrIDsureTokensResult>
        <ProvisioningResult>FailedToAddToBatch or EmailSent or SMSSent or UserHasNoEmail or UserHasNoMobileNumber or FailedToSendEmail or FailedToSendSMS or FailedToSendSMS_NoCredits or CouldntGetToken or CouldntAssignToken or UserHasActiveToken or ProvisionSuccess</ProvisioningResult>
        <ProvisioningResult>FailedToAddToBatch or EmailSent or SMSSent or UserHasNoEmail or UserHasNoMobileNumber or FailedToSendEmail or FailedToSendSMS or FailedToSendSMS_NoCredits or CouldntGetToken or CouldntAssignToken or UserHasActiveToken or ProvisionSuccess</ProvisioningResult>
      </ProvisionUsersGrIDsureTokensResult>
    </ProvisionUsersGrIDsureTokensResponse>
  </soap:Body>
</soap:Envelope>

copy link to clipboardSOAP 1.2 sample

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ProvisionUsersGrIDsureTokens xmlns="http://www.cryptocard.com/blackshield/">
      <userNames>
        <string>string</string>
        <string>string</string>
      </userNames>
      <description>string</description>
      <organization>string</organization>
    </ProvisionUsersGrIDsureTokens>
  </soap12:Body>
</soap12:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ProvisionUsersGrIDsureTokensResponse xmlns="http://www.cryptocard.com/blackshield/">
      <ProvisionUsersGrIDsureTokensResult>
        <ProvisioningResult>FailedToAddToBatch or EmailSent or SMSSent or UserHasNoEmail or UserHasNoMobileNumber or FailedToSendEmail or FailedToSendSMS or FailedToSendSMS_NoCredits or CouldntGetToken or CouldntAssignToken or UserHasActiveToken or ProvisionSuccess</ProvisioningResult>
        <ProvisioningResult>FailedToAddToBatch or EmailSent or SMSSent or UserHasNoEmail or UserHasNoMobileNumber or FailedToSendEmail or FailedToSendSMS or FailedToSendSMS_NoCredits or CouldntGetToken or CouldntAssignToken or UserHasActiveToken or ProvisionSuccess</ProvisioningResult>
      </ProvisionUsersGrIDsureTokensResult>
    </ProvisionUsersGrIDsureTokensResponse>
  </soap12:Body>
</soap12:Envelope>

copy link to clipboardResetGrIDsureTokenPIP

ResetGrIDsureTokenPIP(System.String,System.Byte\[\],System.String,System.String)

Reset the PIP for a GrIDsure token using an initialization key from getGrIDsureTokenInitKey and the correct response.

copy link to clipboardParameters

Param: userName: User with the token

Param: initKey: Initialization key from getGrIDsureTokenInitKey

Param: response: Response to the initialization key

Param: organization: Account

copy link to clipboardReturns

  • True if the PIP was reset

copy link to clipboardSOAP 1.1 sample

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/ResetGrIDsureTokenPIP"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ResetGrIDsureTokenPIP xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <initKey>base64Binary</initKey>
      <response>string</response>
      <organization>string</organization>
    </ResetGrIDsureTokenPIP>
  </soap:Body>
</soap:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ResetGrIDsureTokenPIPResponse xmlns="http://www.cryptocard.com/blackshield/">
      <ResetGrIDsureTokenPIPResult>boolean</ResetGrIDsureTokenPIPResult>
    </ResetGrIDsureTokenPIPResponse>
  </soap:Body>
</soap:Envelope>

copy link to clipboardSOAP 1.2 sample

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ResetGrIDsureTokenPIP xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <initKey>base64Binary</initKey>
      <response>string</response>
      <organization>string</organization>
    </ResetGrIDsureTokenPIP>
  </soap12:Body>
</soap12:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ResetGrIDsureTokenPIPResponse xmlns="http://www.cryptocard.com/blackshield/">
      <ResetGrIDsureTokenPIPResult>boolean</ResetGrIDsureTokenPIPResult>
    </ResetGrIDsureTokenPIPResponse>
  </soap12:Body>
</soap12:Envelope>

copy link to clipboardHTTP GET sample

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

Request:

GET /bsidca/BSIDCA.asmx/ResetGrIDsureTokenPIP?userName=string&initKey=string&initKey=string&response=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>

copy link to clipboardHTTP POST sample

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx/ResetGrIDsureTokenPIP HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

userName=string&initKey=string&initKey=string&response=string&organization=string

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://www.cryptocard.com/blackshield/">boolean</boolean>

copy link to clipboardgetGrIDsureToken

getGrIDsureToken(System.String,System.String)

Get the GrIDsure token for a given user.

copy link to clipboardParameters

Param: userName: User name

Param: organization: Account

copy link to clipboardReturns

  • The user's GrIDsure token (if they have one)

copy link to clipboardSOAP 1.1 sample

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/getGrIDsureToken"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getGrIDsureToken xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <organization>string</organization>
    </getGrIDsureToken>
  </soap:Body>
</soap:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getGrIDsureTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
      <getGrIDsureTokenResult>
        <challengeIssued>boolean</challengeIssued>
        <isICEToken>boolean</isICEToken>
        <OwnerName>string</OwnerName>
        <Organization>string</Organization>
        <OwningOrganization>string</OwningOrganization>
        <State>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</State>
        <PINSetDate>string</PINSetDate>
        <ActivationTime>string</ActivationTime>
        <UnlockTime>string</UnlockTime>
        <StateSetDate>string</StateSetDate>
        <LastAuthDate>string</LastAuthDate>
        <LastSuccessDate>string</LastSuccessDate>
        <Inittime>string</Inittime>
        <Display>string</Display>
        <OTPTTL>int</OTPTTL>
        <OtpLength>int</OtpLength>
        <ActivationCount>int</ActivationCount>
        <EncryptionKey>base64Binary</EncryptionKey>
        <NonHSMKey>base64Binary</NonHSMKey>
        <ChallengeBase>base64Binary</ChallengeBase>
        <AuthAttempts>int</AuthAttempts>
        <Message>string</Message>
        <LastChallengeDate>string</LastChallengeDate>
        <ExpiryDate>string</ExpiryDate>
        <IsTimeBased>boolean</IsTimeBased>
        <TimeInterval>int</TimeInterval>
        <AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
        <ContainerName>string</ContainerName>
        <DeviceName>string</DeviceName>
      </getGrIDsureTokenResult>
    </getGrIDsureTokenResponse>
  </soap:Body>
</soap:Envelope>

copy link to clipboardSOAP 1.2 sample

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getGrIDsureToken xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <organization>string</organization>
    </getGrIDsureToken>
  </soap12:Body>
</soap12:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getGrIDsureTokenResponse xmlns="http://www.cryptocard.com/blackshield/">
      <getGrIDsureTokenResult>
        <challengeIssued>boolean</challengeIssued>
        <isICEToken>boolean</isICEToken>
        <OwnerName>string</OwnerName>
        <Organization>string</Organization>
        <OwningOrganization>string</OwningOrganization>
        <State>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</State>
        <PINSetDate>string</PINSetDate>
        <ActivationTime>string</ActivationTime>
        <UnlockTime>string</UnlockTime>
        <StateSetDate>string</StateSetDate>
        <LastAuthDate>string</LastAuthDate>
        <LastSuccessDate>string</LastSuccessDate>
        <Inittime>string</Inittime>
        <Display>string</Display>
        <OTPTTL>int</OTPTTL>
        <OtpLength>int</OtpLength>
        <ActivationCount>int</ActivationCount>
        <EncryptionKey>base64Binary</EncryptionKey>
        <NonHSMKey>base64Binary</NonHSMKey>
        <ChallengeBase>base64Binary</ChallengeBase>
        <AuthAttempts>int</AuthAttempts>
        <Message>string</Message>
        <LastChallengeDate>string</LastChallengeDate>
        <ExpiryDate>string</ExpiryDate>
        <IsTimeBased>boolean</IsTimeBased>
        <TimeInterval>int</TimeInterval>
        <AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
        <ContainerName>string</ContainerName>
        <DeviceName>string</DeviceName>
      </getGrIDsureTokenResult>
    </getGrIDsureTokenResponse>
  </soap12:Body>
</soap12:Envelope>

copy link to clipboardHTTP GET sample

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

Request:

GET /bsidca/BSIDCA.asmx/getGrIDsureToken?userName=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Token xmlns="http://www.cryptocard.com/blackshield/">
  <challengeIssued>boolean</challengeIssued>
  <isICEToken>boolean</isICEToken>
  <OwnerName>string</OwnerName>
  <Organization>string</Organization>
  <OwningOrganization>string</OwningOrganization>
  <State>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</State>
  <PINSetDate>string</PINSetDate>
  <ActivationTime>string</ActivationTime>
  <UnlockTime>string</UnlockTime>
  <StateSetDate>string</StateSetDate>
  <LastAuthDate>string</LastAuthDate>
  <LastSuccessDate>string</LastSuccessDate>
  <Inittime>string</Inittime>
  <Display>string</Display>
  <OTPTTL>int</OTPTTL>
  <OtpLength>int</OtpLength>
  <ActivationCount>int</ActivationCount>
  <EncryptionKey>base64Binary</EncryptionKey>
  <NonHSMKey>base64Binary</NonHSMKey>
  <ChallengeBase>base64Binary</ChallengeBase>
  <AuthAttempts>int</AuthAttempts>
  <Message>string</Message>
  <LastChallengeDate>string</LastChallengeDate>
  <ExpiryDate>string</ExpiryDate>
  <IsTimeBased>boolean</IsTimeBased>
  <TimeInterval>int</TimeInterval>
  <AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
  <ContainerName>string</ContainerName>
  <DeviceName>string</DeviceName>
</Token>

copy link to clipboardHTTP POST sample

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx/getGrIDsureToken HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

userName=string&organization=string

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Token xmlns="http://www.cryptocard.com/blackshield/">
  <challengeIssued>boolean</challengeIssued>
  <isICEToken>boolean</isICEToken>
  <OwnerName>string</OwnerName>
  <Organization>string</Organization>
  <OwningOrganization>string</OwningOrganization>
  <State>BASE_INVENTORY or NOT_INITIALIZED or REVOKED or INITIALIZED or CORRUPTED_INVENTORY or BASE_ALLOCATED or ALLOCATED or BASE_ASSIGNED or MANUALLY_ASSIGNED or ENROLLED_PIN_CHANGE or ENROLLMENT_PENDING or BASE_ACTIVE or ACTIVE_TOKEN or PIN_CHANGE or BASE_SUSPENDED or MANUAL_SUSPENSION or RULE_SUSPENSION or BASE_LOCKED or SERVER_LOCK or USER_LOCK or PIN_CHANGE_LOCK or CORRUPTED or BASE_LOST_FAILED or LOST_TOKEN or DAMAGED_TOKEN or BASE_DELETED or MANUAL_REMOVE or AUTO_REMOVE or BASE_PURGED or PURGED_TOKEN</State>
  <PINSetDate>string</PINSetDate>
  <ActivationTime>string</ActivationTime>
  <UnlockTime>string</UnlockTime>
  <StateSetDate>string</StateSetDate>
  <LastAuthDate>string</LastAuthDate>
  <LastSuccessDate>string</LastSuccessDate>
  <Inittime>string</Inittime>
  <Display>string</Display>
  <OTPTTL>int</OTPTTL>
  <OtpLength>int</OtpLength>
  <ActivationCount>int</ActivationCount>
  <EncryptionKey>base64Binary</EncryptionKey>
  <NonHSMKey>base64Binary</NonHSMKey>
  <ChallengeBase>base64Binary</ChallengeBase>
  <AuthAttempts>int</AuthAttempts>
  <Message>string</Message>
  <LastChallengeDate>string</LastChallengeDate>
  <ExpiryDate>string</ExpiryDate>
  <IsTimeBased>boolean</IsTimeBased>
  <TimeInterval>int</TimeInterval>
  <AuthVersion>GOLD or CUSTOM or OATH or V4 or V5 or V6 or V7</AuthVersion>
  <ContainerName>string</ContainerName>
  <DeviceName>string</DeviceName>
</Token>

copy link to clipboardgetGrIDsureTokenInitKey

getGrIDsureTokenInitKey(System.String,System.String)

Get the initialization Key for a GrIDsure token.

copy link to clipboardParameters

Param: userName: User with a GrIDsure token

Param: organization: Account

copy link to clipboardReturns

  • Initialization key

copy link to clipboardSOAP 1.1 sample

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.cryptocard.com/blackshield/getGrIDsureTokenInitKey"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getGrIDsureTokenInitKey xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <organization>string</organization>
    </getGrIDsureTokenInitKey>
  </soap:Body>
</soap:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getGrIDsureTokenInitKeyResponse xmlns="http://www.cryptocard.com/blackshield/">
      <getGrIDsureTokenInitKeyResult>base64Binary</getGrIDsureTokenInitKeyResult>
    </getGrIDsureTokenInitKeyResponse>
  </soap:Body>
</soap:Envelope>

copy link to clipboardSOAP 1.2 sample

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getGrIDsureTokenInitKey xmlns="http://www.cryptocard.com/blackshield/">
      <userName>string</userName>
      <organization>string</organization>
    </getGrIDsureTokenInitKey>
  </soap12:Body>
</soap12:Envelope>

Response:

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getGrIDsureTokenInitKeyResponse xmlns="http://www.cryptocard.com/blackshield/">
      <getGrIDsureTokenInitKeyResult>base64Binary</getGrIDsureTokenInitKeyResult>
    </getGrIDsureTokenInitKeyResponse>
  </soap12:Body>
</soap12:Envelope>

copy link to clipboardHTTP GET sample

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

Request:

GET /bsidca/BSIDCA.asmx/getGrIDsureTokenInitKey?userName=string&organization=string HTTP/1.1
Host: cloud.safenet-inc.com

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<base64Binary xmlns="http://www.cryptocard.com/blackshield/">base64Binary</base64Binary>

copy link to clipboardHTTP POST sample

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

Request:

POST /bsidca/BSIDCA.asmx/getGrIDsureTokenInitKey HTTP/1.1
Host: cloud.safenet-inc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

userName=string&organization=string

Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<base64Binary xmlns="http://www.cryptocard.com/blackshield/">base64Binary</base64Binary>